


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Index &mdash; QDMA Linux Driver 2018.3 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="#"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="QDMA Linux Driver 2018.3 documentation" href="index.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> QDMA Linux Driver
          

          
          </a>

          
            
            
              <div class="version">
                2018.3
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="features.html">QDMA Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="system-requirements.html">System Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="build.html">Building and Installing Software Stack</a></li>
<li class="toctree-l1"><a class="reference internal" href="devguide.html">Developers Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="userguide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-app.html">User Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="performance.html">QDMA Performance</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">QDMA Linux Driver</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          





<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
      
    <li></li>
      <li class="wy-breadcrumbs-aside">
        
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#C"><strong>C</strong></a>
 | <a href="#D"><strong>D</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#I"><strong>I</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#Q"><strong>Q</strong></a>
 | <a href="#T"><strong>T</strong></a>
 
</div>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.cmpt_desc_sz_t">cmpt_desc_sz_t (C type)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.desc_sz_t">desc_sz_t (C type)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.drv_mode_name">drv_mode_name (C type)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.global_csr_conf">global_csr_conf (C type)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.intr_ring_size_sel">intr_ring_size_sel (C type)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.libqdma_exit">libqdma_exit (C function)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.libqdma_init">libqdma_init (C function)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.qdma_batch_request_submit">qdma_batch_request_submit (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_cmpl_ctrl">qdma_cmpl_ctrl (C type)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_descq_get_cmpt_udd">qdma_descq_get_cmpt_udd (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_dev_conf">qdma_dev_conf (C type)</a>
</li>
      <li><a href="libqdma_apis.html#c.QDMA_DEV_NAME_MAXLEN">QDMA_DEV_NAME_MAXLEN (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_dev_qmax_state">qdma_dev_qmax_state (C type)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_clear_stats">qdma_device_clear_stats (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_close">qdma_device_close (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_flr_quirk_check">qdma_device_flr_quirk_check (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_flr_quirk_set">qdma_device_flr_quirk_set (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_get_config">qdma_device_get_config (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_get_mmc2h_pkts">qdma_device_get_mmc2h_pkts (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_get_mmh2c_pkts">qdma_device_get_mmh2c_pkts (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_get_stc2h_pkts">qdma_device_get_stc2h_pkts (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_get_sth2c_pkts">qdma_device_get_sth2c_pkts (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_offline">qdma_device_offline (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_online">qdma_device_online (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_open">qdma_device_open (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_read_config_register">qdma_device_read_config_register (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_set_config">qdma_device_set_config (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_sriov_config">qdma_device_sriov_config (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_version_info">qdma_device_version_info (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_device_write_config_register">qdma_device_write_config_register (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_drv_mode">qdma_drv_mode (C type)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_error_codes">qdma_error_codes (C type)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_global_csr_get">qdma_global_csr_get (C function)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.qdma_global_csr_set">qdma_global_csr_set (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_intr_ring_dump">qdma_intr_ring_dump (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_add">qdma_queue_add (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_avail_desc">qdma_queue_avail_desc (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_c2h_peek">qdma_queue_c2h_peek (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_cmpl_ctrl">qdma_queue_cmpl_ctrl (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_conf">qdma_queue_conf (C type)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_dump">qdma_queue_dump (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_dump_cmpt">qdma_queue_dump_cmpt (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_dump_desc">qdma_queue_dump_desc (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_get_config">qdma_queue_get_config (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_list">qdma_queue_list (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_packet_read">qdma_queue_packet_read (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_packet_write">qdma_queue_packet_write (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_prog_stm">qdma_queue_prog_stm (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_reconfig">qdma_queue_reconfig (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_remove">qdma_queue_remove (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_service">qdma_queue_service (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_set_err_induction">qdma_queue_set_err_induction (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_start">qdma_queue_start (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_queue_stop">qdma_queue_stop (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_request">qdma_request (C type)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_request_submit">qdma_request_submit (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_software_version_info">qdma_software_version_info (C function)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_sw_sg">qdma_sw_sg (C type)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_version_info">qdma_version_info (C type)</a>
</li>
      <li><a href="libqdma_apis.html#c.qdma_vf_qconf">qdma_vf_qconf (C function)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="libqdma_apis.html#c.tigger_mode_t">tigger_mode_t (C type)</a>
</li>
  </ul></td>
</tr></table>



           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018-2019, Xilinx, Inc.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'2018.3',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>